home *** CD-ROM | disk | FTP | other *** search
/ PC World 2007 September / PCWorld_2007-09_cd.bin / v cisle / wireshark / wireshark-setup-0.99.6a.exe / snmp / mibs / NET-SNMP-EXAMPLES-MIB.txt < prev    next >
Text File  |  2005-04-20  |  9KB  |  286 lines
  1. NET-SNMP-EXAMPLES-MIB DEFINITIONS ::= BEGIN
  2.  
  3. --
  4. -- Example MIB objects for agent module example implementations
  5. --
  6.  
  7. IMPORTS
  8.     MODULE-IDENTITY, OBJECT-TYPE, Integer32,
  9.     NOTIFICATION-TYPE                       FROM SNMPv2-SMI
  10.     SnmpAdminString                         FROM SNMP-FRAMEWORK-MIB
  11.     netSnmp                                 FROM NET-SNMP-MIB
  12.     RowStatus, StorageType                  FROM SNMPv2-TC
  13.     InetAddressType, InetAddress            FROM INET-ADDRESS-MIB
  14. ;
  15.  
  16. netSnmpExamples MODULE-IDENTITY
  17.     LAST-UPDATED "200406150000Z"
  18.     ORGANIZATION "www.net-snmp.org"
  19.     CONTACT-INFO    
  20.      "postal:   Wes Hardaker
  21.                     P.O. Box 382
  22.                     Davis CA  95617
  23.  
  24.           email:    net-snmp-coders@lists.sourceforge.net"
  25.     DESCRIPTION
  26.     "Example MIB objects for agent module example implementations"
  27.     REVISION     "200406150000Z"
  28.     DESCRIPTION
  29.     "Corrected notification example definitions"
  30.     REVISION     "200202060000Z"
  31.     DESCRIPTION
  32.     "First draft"
  33.     ::= { netSnmp 2 }
  34.  
  35. --
  36. -- top level structure
  37. --
  38. netSnmpExampleScalars       OBJECT IDENTIFIER ::= { netSnmpExamples 1 }
  39. netSnmpExampleTables        OBJECT IDENTIFIER ::= { netSnmpExamples 2 }
  40. netSnmpExampleNotifications OBJECT IDENTIFIER ::= { netSnmpExamples 3 }
  41. netSnmpExampleNotificationPrefix  OBJECT IDENTIFIER
  42.                                   ::= { netSnmpExampleNotifications 0 }
  43. netSnmpExampleNotificationObjects OBJECT IDENTIFIER
  44.                                   ::= { netSnmpExampleNotifications 2 }
  45. -- netSnmpTutorial          OBJECT IDENTIFIER ::= { netSnmpExamples 4 }
  46.  
  47. --
  48. -- Example scalars
  49. --
  50.  
  51. netSnmpExampleInteger OBJECT-TYPE
  52.     SYNTAX      Integer32
  53.     MAX-ACCESS  read-write
  54.     STATUS      current
  55.     DESCRIPTION
  56.     "This is a simple object which merely houses a writable
  57.      integer.  It's only purposes is to hold the value of a single
  58.      integer.  Writing to it will simply change the value for
  59.      subsequent GET/GETNEXT/GETBULK retrievals.
  60.  
  61.      This example object is implemented in the
  62.      agent/mibgroup/examples/scalar_int.c file."
  63.     DEFVAL { 42 }
  64.     ::= { netSnmpExampleScalars 1 }
  65.  
  66. netSnmpExampleSleeper OBJECT-TYPE
  67.     SYNTAX      Integer32
  68.     MAX-ACCESS  read-write
  69.     STATUS      current
  70.     DESCRIPTION
  71.     "This is a simple object which is a basic integer.  It's value
  72.      indicates the number of seconds that the agent will take in
  73.      responding to requests of this object.  This is implemented
  74.      in a way which will allow the agent to keep responding to
  75.      other requests while access to this object is blocked.  It is
  76.      writable, and changing it's value will change the amount of
  77.      time the agent will effectively wait for before returning a
  78.      response when this object is manipulated.  Note that SET
  79.      requests through this object will take longer, since the
  80.      delay is applied to each internal transaction phase, which
  81.      could result in delays of up to 4 times the value of this
  82.      object.
  83.  
  84.      This example object is implemented in the
  85.      agent/mibgroup/examples/delayed_instance.c file."
  86.     DEFVAL { 1 }
  87.     ::= { netSnmpExampleScalars 2 }
  88.  
  89. netSnmpExampleString OBJECT-TYPE
  90.     SYNTAX      Integer32
  91.     MAX-ACCESS  read-write
  92.     STATUS      current
  93.     DESCRIPTION
  94.     "This is a simple object which merely houses a writable
  95.      string.  It's only purposes is to hold the value of a single
  96.      string.  Writing to it will simply change the value for
  97.      subsequent GET/GETNEXT/GETBULK retrievals.
  98.  
  99.      This example object is implemented in the
  100.      agent/mibgroup/examples/watched.c file."
  101.     DEFVAL { "So long, and thanks for all the fish!" }
  102.     ::= { netSnmpExampleScalars 3 }
  103.  
  104.  
  105. --
  106. --  Example Tables
  107. --
  108.  
  109. netSnmpIETFWGTable OBJECT-TYPE
  110.     SYNTAX      SEQUENCE OF NetSnmpIETFWGEntry
  111.     MAX-ACCESS  not-accessible
  112.     STATUS      current
  113.     DESCRIPTION
  114.     "This table merely contains a set of data which is otherwise
  115.      useless for true network management.  It is a table which
  116.      describes properies about a IETF Working Group, such as the
  117.      names of the two working group chairs.
  118.  
  119.      This example table is implemented in the
  120.      agent/mibgroup/examples/data_set.c file."
  121.     ::= { netSnmpExampleTables 1 }
  122.  
  123. netSnmpIETFWGEntry OBJECT-TYPE
  124.     SYNTAX      NetSnmpIETFWGEntry
  125.     MAX-ACCESS  not-accessible
  126.     STATUS      current
  127.     DESCRIPTION
  128.     "A row describing a given working group"
  129.     INDEX   { nsIETFWGName }
  130.     ::= {netSnmpIETFWGTable 1 }
  131.  
  132. NetSnmpIETFWGEntry ::= SEQUENCE {
  133.     nsIETFWGName    OCTET STRING,
  134.     nsIETFWGChair1    OCTET STRING,
  135.     nsIETFWGChair2    OCTET STRING
  136. }
  137.  
  138. nsIETFWGName OBJECT-TYPE
  139.     SYNTAX      OCTET STRING (SIZE(1..32))
  140.     MAX-ACCESS  not-accessible
  141.     STATUS      current
  142.     DESCRIPTION
  143.     "The name of the IETF Working Group this table describes."
  144.     ::= { netSnmpIETFWGEntry 1 }
  145.  
  146. nsIETFWGChair1 OBJECT-TYPE
  147.     SYNTAX      OCTET STRING
  148.     MAX-ACCESS  read-create
  149.     STATUS      current
  150.     DESCRIPTION
  151.     "One of the names of the chairs for the IETF working group."
  152.     ::= { netSnmpIETFWGEntry 2 }
  153.  
  154. nsIETFWGChair2 OBJECT-TYPE
  155.     SYNTAX      OCTET STRING
  156.     MAX-ACCESS  read-create
  157.     STATUS      current
  158.     DESCRIPTION
  159.     "The other name, if one exists, of the chairs for the IETF
  160.     working group."
  161.     ::= { netSnmpIETFWGEntry 3 }
  162.  
  163. --
  164. -- A table used in a table_iterator example
  165. --   (agent/mibgroup/examples/netSnmpHostsTable*.[ch])
  166. --
  167.  
  168. netSnmpHostsTable OBJECT-TYPE
  169.     SYNTAX      SEQUENCE OF NetSnmpHostsEntry
  170.     MAX-ACCESS  not-accessible
  171.     STATUS      current
  172.     DESCRIPTION
  173.     "An example table that implements a wrapper around the
  174.     /etc/hosts file on a machine using the iterator helper API."
  175.     ::= { netSnmpExampleTables 2 }
  176.  
  177. netSnmpHostsEntry OBJECT-TYPE
  178.     SYNTAX      NetSnmpHostsEntry
  179.     MAX-ACCESS  not-accessible
  180.     STATUS      current
  181.     DESCRIPTION
  182.     "A host name mapped to an ip address"
  183.     INDEX   { netSnmpHostName }
  184.     ::= { netSnmpHostsTable 1 }
  185.  
  186. NetSnmpHostsEntry ::= SEQUENCE {
  187.     netSnmpHostName         OCTET STRING,
  188.     netSnmpHostAddressType  InetAddressType,
  189.     netSnmpHostAddress      InetAddress,
  190.     netSnmpHostStorage      StorageType,
  191.     netSnmpHostRowStatus    RowStatus
  192. }
  193.  
  194. netSnmpHostName OBJECT-TYPE
  195.     SYNTAX      OCTET STRING (SIZE(0..64))
  196.     MAX-ACCESS  not-accessible
  197.     STATUS      current
  198.     DESCRIPTION
  199.     "A host name that exists in the /etc/hosts (unix) file."
  200.     ::= { netSnmpHostsEntry 1 }
  201.  
  202. netSnmpHostAddressType OBJECT-TYPE
  203.     SYNTAX      InetAddressType
  204.     MAX-ACCESS  read-create
  205.     STATUS      current
  206.     DESCRIPTION
  207.     "The address type of then given host."
  208.     ::= { netSnmpHostsEntry 2 }
  209.  
  210. netSnmpHostAddress OBJECT-TYPE
  211.     SYNTAX      InetAddress
  212.     MAX-ACCESS  read-create
  213.     STATUS      current
  214.     DESCRIPTION
  215.     "The address of then given host."
  216.     ::= { netSnmpHostsEntry 3 }
  217.  
  218. netSnmpHostStorage OBJECT-TYPE
  219.     SYNTAX       StorageType
  220.     MAX-ACCESS   read-create
  221.     STATUS       current
  222.     DESCRIPTION "The storage type for this conceptual row."
  223.     DEFVAL      { nonVolatile }
  224.     ::= { netSnmpHostsEntry 4 }
  225.  
  226. netSnmpHostRowStatus OBJECT-TYPE
  227.     SYNTAX       RowStatus
  228.     MAX-ACCESS   read-create
  229.     STATUS       current
  230.     DESCRIPTION "The status of this conceptual row."
  231.     ::= { netSnmpHostsEntry 5 }
  232.  
  233.  
  234. --
  235. --  Example Notifications
  236. --
  237.  
  238. netSnmpExampleHeartbeatRate OBJECT-TYPE
  239.     SYNTAX      Integer32
  240.     MAX-ACCESS  accessible-for-notify
  241.     STATUS      current
  242.     DESCRIPTION
  243.         "A simple integer object, to act as a payload for the
  244.          netSnmpExampleHeartbeatNotification.  The value has
  245.          no real meaning, but is nominally the interval (in
  246.          seconds) between successive heartbeat notifications."
  247. ::= { netSnmpExampleNotificationObjects 1 }
  248.  
  249. netSnmpExampleHeartbeatName OBJECT-TYPE
  250.     SYNTAX      SnmpAdminString
  251.     MAX-ACCESS  accessible-for-notify
  252.     STATUS      current
  253.     DESCRIPTION
  254.         "A simple string object, to act as an optional payload
  255.          for the netSnmpExampleHeartbeatNotification.  This varbind
  256.          is not part of the notification definition, so is optional
  257.          and need not be included in the notification payload. 
  258.          The value has no real meaning, but the romantically inclined
  259.          may take it to be the object of the sender's affection,
  260.          and hence the cause of the heart beating faster."
  261. ::= { netSnmpExampleNotificationObjects 2 }
  262.  
  263. netSnmpExampleHeartbeatNotification NOTIFICATION-TYPE
  264.     OBJECTS     { netSnmpExampleHeartbeatRate }
  265.     STATUS      current
  266.     DESCRIPTION
  267.         "An example notification, used to illustrate the
  268.          definition and generation of trap and inform PDUs
  269.          (including the use of both standard and additional
  270.          varbinds in the notification payload).
  271.          This notification will typically be sent every
  272.      30 seconds, using the code found in the example module
  273.              agent/mibgroup/examples/notification.c"
  274. ::= { netSnmpExampleNotificationPrefix 1 }
  275.     
  276. netSnmpExampleNotification OBJECT-TYPE
  277.     SYNTAX      SnmpAdminString
  278.     MAX-ACCESS  accessible-for-notify
  279.     STATUS      obsolete
  280.     DESCRIPTION
  281.         "This object was improperly defined for its original purpose,
  282.          and should no longer be used."
  283. ::= { netSnmpExampleNotifications 1 }
  284.  
  285. END
  286.